Skip to content

Added documentation for the example command#274

Merged
nehagup merged 8 commits intokeploy:mainfrom
jaimin001:main
Dec 7, 2023
Merged

Added documentation for the example command#274
nehagup merged 8 commits intokeploy:mainfrom
jaimin001:main

Conversation

@jaimin001
Copy link
Copy Markdown
Contributor

Pull Request Template

Description

Added documentation for the example command, including flag details for --customSetup.

Fixes #1153

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • I have added corresponding tests.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you and congratulations 🎉 for opening your very first pull request in keploy

@nehagup nehagup requested a review from Shashwat79802 December 5, 2023 06:05
@Shashwat79802
Copy link
Copy Markdown
Contributor

Please sign the DCO. Use the -s flag while committing.

@Shashwat79802
Copy link
Copy Markdown
Contributor

image

Please fix this, the Usage is not displayed properly upon building and starting the site locally.

@Shashwat79802
Copy link
Copy Markdown
Contributor

Shashwat79802 commented Dec 6, 2023

Please sign the DCO. See details of your failing check to understand how to sign it.

jaimin001 and others added 4 commits December 6, 2023 19:03
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
Signed-off-by: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com>
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
@Shashwat79802
Copy link
Copy Markdown
Contributor

A small change to maintain the consistency in the docs, after specifying the --customSetup flag, replace the colon (-) with a hyphen (-) with the correct spacing as the other flags.

Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
@nehagup nehagup merged commit 8819d7c into keploy:main Dec 7, 2023
github-actions Bot pushed a commit that referenced this pull request Dec 7, 2023
* Added documentation for the `example` command

Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>

* fixed the usage command at display when run locally

Signed-off-by: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com>
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>

* fix: fixed typo in samples-bunjs (#273)

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>

* updated a line for better interpretation

Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>

* updated : with - for consistency

Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>

---------

Signed-off-by: Jaimin Gajjar <jaimingajjar01@gmail.com>
Signed-off-by: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Co-authored-by: Asish Kumar <87874775+officialasishkumar@users.noreply.github.com>
Co-authored-by: Neha Gupta <gneha21@yahoo.in>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs]: add the documentation for keploy's example command

4 participants